package com.pzy.base.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
@Schema(description = "api响应信息")
public class ApiResponse<T> {
    /**
     * 业务接口状态码
     * ---
     * - 200: 执行成功
     * - 400: 请求参数不符合接口要求
     * - 4000: 数据未通过验证/预期业务异常
     * - 404: 资源未找到异常
     * - 405: 调用端发起了不支持的请求方式(如: 接口仅支持POST, 调用端使用GET)
     * - 500: 服务内部发生非预期异常
     */
    @Schema(description = "业务接口状态码. 200: 执行成功. 400: 请求参数不符合接口要求. 4000: 数据未通过验证/预期业务异常. 404: 资源未找到异常. 405: 调用端发起了不支持的请求方式(如: 接口仅支持POST, 调用端使用GET). 500: 服务内部发生非预期异常")
    private int code;
    /**
     * 异常提示信息
     */
    @Schema(description = "异常提示信息")
    private String message;
    /**
     * 实际的业务数据
     */
    @Schema(description = "实际的业务数据")
    private T data; // 返回数据

    public static <T> ApiResponse<T> success(T data) {
        return new ApiResponse<>(200, null, data);
    }

    /**
     * 构建异常响应
     * ---
     * - 400: 请求参数不符合接口要求
     * - 4000: 数据未通过验证/预期业务异常
     * - 404: 资源未找到异常
     * - 405: 调用端发起了不支持的请求方式(如: 接口仅支持POST, 调用端使用GET)
     * - 500: 服务内部发生非预期异常
     * 
     * @param <T>
     * @param code    响应状态码
     * @param message 异常提示信息
     * @return
     */
    public static <T> ApiResponse<T> error(int code, String message) {
        return new ApiResponse<>(code, message, null);
    }

    /**
     * 构建预期的业务异常响应
     * 
     * @param <T>
     * @param message 业务异常提示信息
     * @return
     */
    public static <T> ApiResponse<T> bizError(String message) {
        return new ApiResponse<>(4000, message, null);
    }

}
